Get all activities for the specified organization.
GET/partner/v1.0/organizations/:organizationId/activities
Get all activities for the specified organization.
Request
Path Parameters
The ID of the organization
Query Parameters
Optional inventory ID to filter by
Default value: 50
Maximum number of results to return (default 50, max 1000)
Default value: 0
Number of results to skip for pagination (default 0)
Responses
- 200
OK
- text/plain
- application/json
- text/json
- Schema
- Example (from schema)
Schema
Array [
- Activity
- EnergyActivity
- FuelActivity
- TransportActivity
- PurchasedGoodActivity
- CapitalGoodActivity
- WasteDisposalActivity
- AccommodationActivity
- ProductSaleActivity
- InvestmentActivity
- HomeOfficeActivity
- WaterUseActivity
- FugitiveGasActivity
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
]
data
object[]
nullable
A page of activities.
oneOf
Base class for activity data representing carbon-emitting events.
Use the "category" field to specify the activity type.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Activity representing energy consumption (electricity, heating, cooling).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
circular(EnergyActivity)
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
Activity representing fuel consumption (gasoline, diesel, natural gas, etc.).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
circular(FuelActivity)
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
Activity representing transportation (business travel, freight, employee commuting).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
circular(TransportActivity)
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Activity representing purchased goods and services.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
circular(PurchasedGoodActivity)
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
Activity representing capital goods (equipment, machinery, buildings).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
circular(CapitalGoodActivity)
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
Activity representing waste disposal and treatment.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
circular(WasteDisposalActivity)
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Activity representing hotel/accommodation stays for business travel.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
circular(AccommodationActivity)
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
Activity representing product sales (for downstream emissions tracking).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
circular(ProductSaleActivity)
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Activity representing investments (financed emissions).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
circular(InvestmentActivity)
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of investment.
Data provider for this activity data.
Activity representing home office/remote work emissions.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
circular(HomeOfficeActivity)
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
Activity representing water usage.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
circular(WaterUseActivity)
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of water usage.
Data provider for this activity data.
Activity representing fugitive gas emissions (refrigerants, other GHGs).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
circular(FugitiveGasActivity)
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
The total number of activities matching the query.
{
"data": [
{},
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null
],
"totalCount": 0
}
- Schema
- Example (from schema)
Schema
Array [
- Activity
- EnergyActivity
- FuelActivity
- TransportActivity
- PurchasedGoodActivity
- CapitalGoodActivity
- WasteDisposalActivity
- AccommodationActivity
- ProductSaleActivity
- InvestmentActivity
- HomeOfficeActivity
- WaterUseActivity
- FugitiveGasActivity
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
]
data
object[]
nullable
A page of activities.
oneOf
Base class for activity data representing carbon-emitting events.
Use the "category" field to specify the activity type.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Activity representing energy consumption (electricity, heating, cooling).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
circular(EnergyActivity)
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
Activity representing fuel consumption (gasoline, diesel, natural gas, etc.).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
circular(FuelActivity)
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
Activity representing transportation (business travel, freight, employee commuting).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
circular(TransportActivity)
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Activity representing purchased goods and services.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
circular(PurchasedGoodActivity)
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
Activity representing capital goods (equipment, machinery, buildings).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
circular(CapitalGoodActivity)
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
Activity representing waste disposal and treatment.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
circular(WasteDisposalActivity)
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Activity representing hotel/accommodation stays for business travel.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
circular(AccommodationActivity)
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
Activity representing product sales (for downstream emissions tracking).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
circular(ProductSaleActivity)
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Activity representing investments (financed emissions).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
circular(InvestmentActivity)
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of investment.
Data provider for this activity data.
Activity representing home office/remote work emissions.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
circular(HomeOfficeActivity)
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
Activity representing water usage.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
circular(WaterUseActivity)
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of water usage.
Data provider for this activity data.
Activity representing fugitive gas emissions (refrigerants, other GHGs).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
circular(FugitiveGasActivity)
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
The total number of activities matching the query.
{
"data": [
{},
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null
],
"totalCount": 0
}
- Schema
- Example (from schema)
Schema
Array [
- Activity
- EnergyActivity
- FuelActivity
- TransportActivity
- PurchasedGoodActivity
- CapitalGoodActivity
- WasteDisposalActivity
- AccommodationActivity
- ProductSaleActivity
- InvestmentActivity
- HomeOfficeActivity
- WaterUseActivity
- FugitiveGasActivity
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
- Energy
- Fuel
- Transport
- Purchased Goods
- Capital Goods
- Waste Disposal
- Accommodation
- Product Sale
- Investment
- Home Office
- Water
- Fugitive Gases
Array [
]
Array [
]
Array [
- CustomFieldValue
- TextCustomFieldValue
- SelectCustomFieldValue
- MultiSelectCustomFieldValue
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
- Text
- Select
- Multi-Select
]
Array [
]
Array [
]
]
data
object[]
nullable
A page of activities.
oneOf
Base class for activity data representing carbon-emitting events.
Use the "category" field to specify the activity type.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Activity representing energy consumption (electricity, heating, cooling).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
circular(EnergyActivity)
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
Activity representing fuel consumption (gasoline, diesel, natural gas, etc.).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
circular(FuelActivity)
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
Activity representing transportation (business travel, freight, employee commuting).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
circular(TransportActivity)
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Activity representing purchased goods and services.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
circular(PurchasedGoodActivity)
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
Activity representing capital goods (equipment, machinery, buildings).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
circular(CapitalGoodActivity)
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
Activity representing waste disposal and treatment.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
circular(WasteDisposalActivity)
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Activity representing hotel/accommodation stays for business travel.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
circular(AccommodationActivity)
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
Activity representing product sales (for downstream emissions tracking).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
circular(ProductSaleActivity)
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Activity representing investments (financed emissions).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
circular(InvestmentActivity)
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of investment.
Data provider for this activity data.
Activity representing home office/remote work emissions.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
circular(HomeOfficeActivity)
The specific type of water usage.
Data provider for this activity data.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
Activity representing water usage.
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
circular(WaterUseActivity)
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of water usage.
Data provider for this activity data.
Activity representing fugitive gas emissions (refrigerants, other GHGs).
category
string
required
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Investment, Home Office, Water, Fugitive Gases]
The specific type of energy (e.g., "Electricity", "Natural Gas", "District Heating").
Data provider for this activity data.
The specific type of fuel (e.g., "Diesel", "Gasoline", "LPG").
Data provider for this activity data.
The specific type of fuel (e.g., "Petrol", "Battery EV (BEV)").
Data provider for this activity data.
Type of vehicle (e.g., "Car", "Truck", "Aircraft").
Vehicle category (e.g., "Small", "Medium", "Large").
Possible values: [Owned, Business Travel, Leased To Others, Leased From Others, Franchise, Employee, Upstream Distribution, Downstream Distribution]
Vehicle model name.
Vehicle license plate number.
Number of passengers for shared transport.
Freight weight in tonnes for goods transport.
Number of days for employee travel activities.
destination
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of purchased good.
Data provider for this activity data.
Category of the purchased good (e.g., "Recreation and Culture", "Insurance Services").
Stock Keeping Unit identifier.
Article number.
Purchase order number.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
ID of a similar product for emission factor matching.
The specific type of capital good.
Data provider for this activity data.
Category of the capital good (e.g., "Machinery", "Vehicles", "Buildings").
The specific type of waste.
Data provider for this activity data.
Waste treatment method (e.g., "Landfill", "Incineration", "Recycling").
Type of accommodation (e.g., "Hotel").
Number of rooms booked.
Number of nights per room.
The specific type of product sold.
Data provider for this activity data.
Category of the product sold.
Article number.
Stock Keeping Unit identifier.
ID of a similar product for emission factor matching.
emissionFactors
object[]
nullable
Customer-provided emission factors for this product.
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
The emission factor value in kg CO2e per unit.
resourceUse
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
resourceUseDuration
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
Power consumption in watts.
usePerYear
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
The specific type of investment.
Data provider for this activity data.
Type of home office activity (e.g., "Office Equipment + Heating", "Office Equipment Only", "Heating Only").
Number of employees working from home.
Number of holidays during the period.
Percentage of working time (0-1).
Percentage of time working from home (0-1).
The specific type of water usage.
Data provider for this activity data.
circular(FugitiveGasActivity)
Unique identifier for this activity within your source system. Used with SourceSystem for idempotency to prevent duplicate imports.
The ID of the GHG inventory to which this activity belongs.
Subsidiary ID for the activity.
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Supplier ID if the activity is associated with a supplier.
Name of the supplier.
supplierLocation
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
Facility ID where the activity occurred.
Supplier's facility ID if applicable.
Additional notes about the activity.
customFieldValues
object[]
nullable
Custom field values associated with this activity.
oneOf
Represents a custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
Represents a text custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
circular(TextCustomFieldValue)
The value of the multi-select custom field.
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the text custom field.
Represents a select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
circular(SelectCustomFieldValue)
The values of the multi-select custom field.
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The value of the multi-select custom field.
Represents a multi-select custom field value.
type
string
required
Possible values: [Text, Select, Multi-Select]
The value of the text custom field.
The value of the multi-select custom field.
circular(MultiSelectCustomFieldValue)
Possible values: non-empty
The unique identifier of the custom field this value is associated with.
The values of the multi-select custom field.
Activity amount (quantity).
Unit of measurement for the amount (e.g., "kWh", "L", "km").
Invoice number for reference.
Pre-calculated emissions in kg CO2e if available. When set, this value is used instead of calculating emissions from emission factors.
externalIds
object[]
nullable
External identifiers for this activity in your systems.
Used for idempotency to prevent duplicate imports.
Example: { Name: "SAP", Value: "DOC-12345-LINE-001" }
The name of the system (e.g., "SAP", "Workday", "Snowflake") where this ID is from.
The unique identifier value from the system.
Possible values: [Owned, Leased To Others, Leased From Others, Franchise, Supplier Factory, Non-Leased Upstream, Non-Leased Downstream]
emissions
object[]
nullable
Pre-calculated emission entries for this activity.
When provided, these emissions are stored directly instead of calculating from emission factors.
The ID of the emission entry.
The timestamp of when the emission was created.
Total emissions in kg CO2e.
ID of the activity this emission belongs to.
The ID of the GHG inventory to which this emission belongs.
Possible values: [Energy, Fuel, Transport, Purchased Goods, Capital Goods, Waste Disposal, Accommodation, Product Sale, Home Office, Investment, Unknown, Water, Fugitive Gases]
Start date/time of the activity period.
End date/time of the activity period.
Possible values: [Real Data, Proxy, System Proxy]
Facility ID where the activity occurred.
Supplier ID if the activity is associated with a supplier.
Supplier's facility ID if applicable.
Subsidiary ID for the emission.
ID of the emission factor used for calculation.
Source of the emission factor (e.g., "DEFRA", "EPA", "Ecoinvent").
Possible values: [Default, Custom, Product Footprint, Facility Specific, Representative Product, Unknown]
Possible values: [Scope 1, Scope 2, Scope 3]
Possible values: [Purchased Goods and services, Capital Goods, Fuel and Energy related activities, Upstream Transportation and Distribution, Waste generated in operations, Business Travel, Employee Commuting, Upstream Leased Assets, Downstream Transportation and Distribution, Processing of sold products, Use of sold products, End of life treatment of sold products, Downstream Leased Assets, Franchises, Investments]
Possible values: [Location Based, Market Based]
Percentage of emissions calculated using primary data (0-100).
Name of the emission factor used.
emissionFactorValue
object
Represents a numeric value with its unit of measurement.
The numeric value.
The unit of measurement (e.g., "kWh", "hours", "years").
location
object
Represents a geographical location where a manufacturing process or material sourcing takes place.
The unique identifier of the location.
The name of the city.
Possible values: non-empty
The ISO 3166-1 alpha-2 country code.
The full name of the country.
The name of the continent.
The latitude coordinate of the location.
The longitude coordinate of the location.
The specific type of fugitive gas (e.g., "R-134a", "CO2", "SF6").
Data provider for this activity data.
Vehicle license plate if applicable (e.g., for vehicle AC refrigerants).
The total number of activities matching the query.
{
"data": [
{},
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null,
null
],
"totalCount": 0
}